// 版权所有2009 Go作者。版权所有。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

// utf8包实现函数和常量，以支持以
// UTF-8编码的文本。它包括在符文和UTF-8字节序列之间转换的函数。
// 参见https:
package utf8

// 在测试中验证了RuneError==unicode.ReplacementChar和
// MaxRune==unicode.MaxRune的条件。
// 在本地定义它们可以避免此包依赖于包unicode。

// 编码的基本数字。
const (
	RuneError = '\uFFFD'     // 错误”符文或“Unicode替换字符”
	RuneSelf  = 0x80         // 符文本身下面的字符以单个字节表示。
	MaxRune   = '\U0010FFFF' // 最大有效Unicode代码点。
	UTFMax    = 4            // UTF-8编码的Unicode字符的最大字节数。
)

// 代理项范围中的代码点对UTF-8无效。
const (
	surrogateMin = 0xD800
	surrogateMax = 0xDFFF
)

const (
	t1 = 0b00000000
	tx = 0b10000000
	t2 = 0b11000000
	t3 = 0b11100000
	t4 = 0b11110000
	t5 = 0b11111000

	maskx = 0b00111111
	mask2 = 0b00011111
	mask3 = 0b00001111
	mask4 = 0b00000111

	rune1Max = 1<<7 - 1
	rune2Max = 1<<11 - 1
	rune3Max = 1<<16 - 1

	// 默认的最低和最高连续字节。
	locb = 0b10000000
	hicb = 0b10111111

	// 选择这些常量的名称是为了在下表中提供良好的对齐。第一个半字节是对
	// 特殊单字节情况的接受范围或F的索引。第二个半字节是特殊单字节大小写的符文长度或
	// 状态。
	xx = 0xF1 // 无效：尺寸1 
	as = 0xF0 // ASCII：尺寸1 
	s1 = 0x02 // 接受0，尺寸2 
	s2 = 0x13 // 接受1，尺寸3 
	s3 = 0x03 // 接受0，尺寸3 
	s4 = 0x23 // 接受2，尺寸3 
	s5 = 0x34 // 接受3，尺寸4 
	s6 = 0x04 // 接受0，尺寸4 
)

// 第一个是关于UTF-8序列中第一个字节的信息。
var first = [256]uint8{
	// 1 2 3 4 5 6 7 8 9 
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x00-0x0F 
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x10-0x1F 
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x20-0x2F 
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x30-0x3F 
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x40-0x4F 
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x50-0x5F 
	as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, as, // 0x60-0x6F 
	xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0x80-0x8F 
	xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0x90-0x9F 
	xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0xA0-0xAF 
	xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0xB0-0xBF 
	xx, xx, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, // 0xC0-0xCF 
	s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, s1, // 0xD0-0xDF 
	s2, s3, s3, s3, s3, s3, s3, s3, s3, s3, s3, s3, s3, s4, s3, s3, // 0xE0-0xE0 
	s5, s6, s6, s6, s7, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, xx, // 0xF0-0xFF 
}

// 接受范围UTF-8 
// 序列中第二个字节的有效值范围。
type acceptRange struct {
	lo uint8 // 第二个字节的最小值。
	hi uint8 // 第二个字节的最大值。
}

// acceptRanges的大小为16，以避免在使用它的代码中进行边界检查。
var acceptRanges = [16]acceptRange{
	0: {locb, hicb},
	1: {0xA0, hicb},
	2: {locb, 0x9F},
	3: {0x90, hicb},
	4: {locb, 0x8F},
}

// FullRune报告p中的字节是否以符文的完整UTF-8编码开始。
// 无效编码被视为完整符文，因为它将转换为宽度为1的错误符文。
func FullRune(p []byte) bool {
	n := len(p)
	if n == 0 {
		return false
	}
	x := first[p[0]]
	if n >= int(x&7) {
		return true // ASCII，无效或有效。
	}
	// 必须短或无效。
	accept := acceptRanges[x>>4]
	if n > 1 && (p[1] < accept.lo || accept.hi < p[1]) {
		return true
	} else if n > 2 && (p[2] < locb || hicb < p[2]) {
		return true
	}
	return false
}

// FullRuneInString类似于FullRune，但其输入是字符串。
func FullRuneInString(s string) bool {
	n := len(s)
	if n == 0 {
		return false
	}
	x := first[s[0]]
	if n >= int(x&7) {
		return true // ASCII，无效或有效。
	}
	// 必须短或无效。
	accept := acceptRanges[x>>4]
	if n > 1 && (s[1] < accept.lo || accept.hi < s[1]) {
		return true
	} else if n > 2 && (s[2] < locb || hicb < s[2]) {
		return true
	}
	return false
}

// DecodeRune将第一个UTF-8编码解包为p，并返回rune和
// 其宽度（以字节为单位）。如果p为空，则返回（RuneError，0）。否则，如果
// 编码无效，则返回（RuneError，1）。这两个都是不可能的
// 正确的非空UTF-8的结果。
// 
// 如果编码的UTF-8不正确，编码的符文超出范围，或者不是
// 值的最短UTF-8编码，则编码无效。未执行其他验证。
func DecodeRune(p []byte) (r rune, size int) {
	n := len(p)
	if n < 1 {
		return RuneError, 0
	}
	p0 := p[0]
	x := first[p0]
	if x >= as {
		// 下面的代码模拟对x==xx和
		// 的附加检查，相应地处理ASCII和无效情况。此掩码和/或
		// 方法阻止附加分支。
		mask := rune(x) << 31 >> 31 // 创建0x0000或0xFFFF。
		return rune(p[0])&^mask | RuneError&mask, 1
	}
	sz := int(x & 7)
	accept := acceptRanges[x>>4]
	if n < sz {
		return RuneError, 1
	}
	b1 := p[1]
	if b1 < accept.lo || accept.hi < b1 {
		return RuneError, 1
	}
	if sz <= 2 { // <=代替==以帮助编译器消除某些边界检查。如果s是
		return rune(p0&mask2)<<6 | rune(b1&maskx), 2
	}
	b2 := p[2]
	if b2 < locb || hicb < b2 {
		return RuneError, 1
	}
	if sz <= 3 {
		return rune(p0&mask3)<<12 | rune(b1&maskx)<<6 | rune(b2&maskx), 3
	}
	b3 := p[3]
	if b3 < locb || hicb < b3 {
		return RuneError, 1
	}
	return rune(p0&mask4)<<18 | rune(b1&maskx)<<12 | rune(b2&maskx)<<6 | rune(b3&maskx), 4
}

// 则返回空值（RuneError，0）。否则，如果编码无效，则返回（RuneError，1）。对于正确的非空
// UTF-8，这两种结果都是不可能的。
// 
// 如果编码的UTF-8不正确，编码的符文超出范围，或者不是
// 值的最短UTF-8编码，则编码无效。未执行其他验证。
func DecodeRuneInString(s string) (r rune, size int) {
	n := len(s)
	if n < 1 {
		return RuneError, 0
	}
	s0 := s[0]
	x := first[s0]
	if x >= as {
		// 下面的代码模拟对x==xx和
		// 相应地处理ASCII和无效案例。此掩码和/或
		// 方法阻止附加分支。
		mask := rune(x) << 31 >> 31 // 创建0x0000或0xFFFF。
		return rune(s[0])&^mask | RuneError&mask, 1
	}
	sz := int(x & 7)
	accept := acceptRanges[x>>4]
	if n < sz {
		return RuneError, 1
	}
	s1 := s[1]
	if s1 < accept.lo || accept.hi < s1 {
		return RuneError, 1
	}
	if sz <= 2 { // <=代替==以帮助编译器消除某些边界检查
		return rune(s0&mask2)<<6 | rune(s1&maskx), 2
	}
	s2 := s[2]
	if s2 < locb || hicb < s2 {
		return RuneError, 1
	}
	if sz <= 3 {
		return rune(s0&mask3)<<12 | rune(s1&maskx)<<6 | rune(s2&maskx), 3
	}
	s3 := s[3]
	if s3 < locb || hicb < s3 {
		return RuneError, 1
	}
	return rune(s0&mask4)<<18 | rune(s1&maskx)<<12 | rune(s2&maskx)<<6 | rune(s3&maskx), 4
}

// DecodeLastRune将最后一个UTF-8编码解包为p，并返回rune和
// 其宽度（字节）。如果p为空，则返回（RuneError，0）。否则，如果
// 编码无效，则返回（RuneError，1）。这两个都是不可能的
// 正确的非空UTF-8的结果。
// 
// 如果编码的UTF-8不正确，编码的符文超出范围，或者不是
// 值的最短UTF-8编码，则该编码无效。未执行其他验证。
func DecodeLastRune(p []byte) (r rune, size int) {
	end := len(p)
	if end == 0 {
		return RuneError, 0
	}
	start := end - 1
	r = rune(p[start])
	if r < RuneSelf {
		return r, 1
	}
	// 在向后遍历包含长序列
	// 的字符串时防止O（n^2）行为无效UTF-8。
	lim := end - UTFMax
	if lim < 0 {
		lim = 0
	}
	for start--; start >= lim; start-- {
		if RuneStart(p[start]) {
			break
		}
	}
	if start < 0 {
		start = 0
	}
	r, size = DecodeRune(p[start:end])
	if start+size != end {
		return RuneError, 1
	}
	return r, size
}

// decodelastruneinnstring类似于DecodeLastRune，但其输入是字符串。如果
// s为空，则返回（RuneError，0）。否则，如果编码无效，则返回（RuneError，1）。对于正确的
// 非空UTF-8，这两种结果都是不可能的。
// 
// 如果编码的UTF-8不正确，编码的符文超出范围，或者不是
// 值的最短UTF-8编码，则编码无效。未执行其他验证。
func DecodeLastRuneInString(s string) (r rune, size int) {
	end := len(s)
	if end == 0 {
		return RuneError, 0
	}
	start := end - 1
	r = rune(s[start])
	if r < RuneSelf {
		return r, 1
	}
	// 在向后遍历包含长序列
	// 的字符串时防止O（n^2）行为无效UTF-8。
	lim := end - UTFMax
	if lim < 0 {
		lim = 0
	}
	for start--; start >= lim; start-- {
		if RuneStart(s[start]) {
			break
		}
	}
	if start < 0 {
		start = 0
	}
	r, size = DecodeRuneInString(s[start:end])
	if start+size != end {
		return RuneError, 1
	}
	return r, size
}

// RuneLen返回对符文进行编码所需的字节数。
// 如果符文不是要在UTF-8中编码的有效值，则返回-1。
func RuneLen(r rune) int {
	switch {
	case r < 0:
		return -1
	case r <= rune1Max:
		return 1
	case r <= rune2Max:
		return 2
	case surrogateMin <= r && r <= surrogateMax:
		return -1
	case r <= rune3Max:
		return 3
	case r <= MaxRune:
		return 4
	}
	return -1
}

// EncodeRune将符文的UTF-8编码写入p（必须足够大）。
// 如果符文超出范围，则写入符文错误的编码。
// 返回写入的字节数。
func EncodeRune(p []byte, r rune) int {
	// 负值错误。让它不签名可以解决这个问题。
	switch i := uint32(r); {
	case i <= rune1Max:
		p[0] = byte(r)
		return 1
	case i <= rune2Max:
		_ = p[1] // 消除边界检查
		p[0] = t2 | byte(r>>6)
		p[1] = tx | byte(r)&maskx
		return 2
	case i > MaxRune, surrogateMin <= i && i <= surrogateMax:
		r = RuneError
		fallthrough
	case i <= rune3Max:
		_ = p[2] // 消除边界检查
		p[0] = t3 | byte(r>>12)
		p[1] = tx | byte(r>>6)&maskx
		p[2] = tx | byte(r)&maskx
		return 3
	default:
		_ = p[3] // 消除边界检查
		p[0] = t4 | byte(r>>18)
		p[1] = tx | byte(r>>12)&maskx
		p[2] = tx | byte(r>>6)&maskx
		p[3] = tx | byte(r)&maskx
		return 4
	}
}

// RuneCount返回p中的符文数。错误和简短的
// 编码被视为宽度为1字节的单个符文。
func RuneCount(p []byte) int {
	np := len(p)
	var n int
	for i := 0; i < np; {
		n++
		c := p[i]
		if c < RuneSelf {
			// ASCII快速路径
			i++
			continue
		}
		x := first[c]
		if x == xx {
			i++ // 无效。
			continue
		}
		size := int(x & 7)
		if i+size > np {
			i++ // 短或无效。
			continue
		}
		accept := acceptRanges[x>>4]
		if c := p[i+1]; c < accept.lo || accept.hi < c {
			size = 1
		} else if size == 2 {
		} else if c := p[i+2]; c < locb || hicb < c {
			size = 1
		} else if size == 3 {
		} else if c := p[i+3]; c < locb || hicb < c {
			size = 1
		}
		i += size
	}
	return n
}

// RuneCountInstalling类似于RuneCount，但其输入是字符串。
func RuneCountInString(s string) (n int) {
	ns := len(s)
	for i := 0; i < ns; n++ {
		c := s[i]
		if c < RuneSelf {
			// ASCII快速路径
			i++
			continue
		}
		x := first[c]
		if x == xx {
			i++ // 无效。
			continue
		}
		size := int(x & 7)
		if i+size > ns {
			i++ // 短或无效。
			continue
		}
		accept := acceptRanges[x>>4]
		if c := s[i+1]; c < accept.lo || accept.hi < c {
			size = 1
		} else if size == 2 {
		} else if c := s[i+2]; c < locb || hicb < c {
			size = 1
		} else if size == 3 {
		} else if c := s[i+3]; c < locb || hicb < c {
			size = 1
		}
		i += size
	}
	return n
}

// RuneStart报告该字节是否可能是编码的、可能无效的rune的第一个字节。第二个字节和后续字节的前两个
// 位总是设置为10。
func RuneStart(b byte) bool { return b&0xC0 != 0x80 }

// 有效报告p是否完全由有效的UTF-8编码符文组成。
func Valid(p []byte) bool {
	// 快速路径。每次迭代检查并跳过8字节的ASCII字符。
	for len(p) >= 8 {
		// 组合两个32位加载允许在32位和64位平台上使用相同的代码。
		// 编译器可以在许多平台上为first32和second32生成32位加载。请参阅test/codegen/memcombine.go。
		first32 := uint32(p[0]) | uint32(p[1])<<8 | uint32(p[2])<<16 | uint32(p[3])<<24
		second32 := uint32(p[4]) | uint32(p[5])<<8 | uint32(p[6])<<16 | uint32(p[7])<<24
		if (first32|second32)&0x80808080 != 0 {
			// 找到一个非ASCII字节（>=RuneSelf）。
			break
		}
		p = p[8:]
	}
	n := len(p)
	for i := 0; i < n; {
		pi := p[i]
		if pi < RuneSelf {
			i++
			continue
		}
		x := first[pi]
		if x == xx {
			return false // 起始字节非法。
		}
		size := int(x & 7)
		if i+size > n {
			return false // 短或无效。
		}
		accept := acceptRanges[x>>4]
		if c := p[i+1]; c < accept.lo || accept.hi < c {
			return false
		} else if size == 2 {
		} else if c := p[i+2]; c < locb || hicb < c {
			return false
		} else if size == 3 {
		} else if c := p[i+3]; c < locb || hicb < c {
			return false
		}
		i += size
	}
	return true
}

// ValidString报告s是否完全由有效的UTF-8编码符文组成。
func ValidString(s string) bool {
	// 快速路径。每次迭代检查并跳过8字节的ASCII字符。
	for len(s) >= 8 {
		// 组合两个32位加载允许在32位和64位平台上使用相同的代码。
		// 编译器可以在许多平台上为first32和second32生成32位加载。请参阅test/codegen/memcombine.go。
		first32 := uint32(s[0]) | uint32(s[1])<<8 | uint32(s[2])<<16 | uint32(s[3])<<24
		second32 := uint32(s[4]) | uint32(s[5])<<8 | uint32(s[6])<<16 | uint32(s[7])<<24
		if (first32|second32)&0x80808080 != 0 {
			// 找到一个非ASCII字节（>=RuneSelf）。
			break
		}
		s = s[8:]
	}
	n := len(s)
	for i := 0; i < n; {
		si := s[i]
		if si < RuneSelf {
			i++
			continue
		}
		x := first[si]
		if x == xx {
			return false // 起始字节非法。
		}
		size := int(x & 7)
		if i+size > n {
			return false // 短或无效。
		}
		accept := acceptRanges[x>>4]
		if c := s[i+1]; c < accept.lo || accept.hi < c {
			return false
		} else if size == 2 {
		} else if c := s[i+2]; c < locb || hicb < c {
			return false
		} else if size == 3 {
		} else if c := s[i+3]; c < locb || hicb < c {
			return false
		}
		i += size
	}
	return true
}

// ValidRune报告r是否可以合法编码为UTF-8。
// 超出范围的代码点或代理的一半是非法的。
func ValidRune(r rune) bool {
	switch {
	case 0 <= r && r < surrogateMin:
		return true
	case surrogateMax < r && r <= MaxRune:
		return true
	}
	return false
}
